• a5_finddupsgenie Function
• a5_get_recs_in_qry_local Function
• a5_paste_current_record Function
• a5_paste_from_clipboard Function
• a5_paste_new_record Function
• a5_put_rec_on_clipboard Function
• a5_rec_clip_has_data Function
• a5_records_undelete Function
• a5_remove_recs_genie Function
• a5_selected_records Function
• BOTTOM_PERCENT_RECORDS Function
• BOTTOM_RECORDS Function
• CHANGE_RECORD Method
• CURRENT_RECORD Function
• CURRENT_RECORD_NUMBER Function
• DBAVG Function
• DBCOUNT Function
• DBMAX Function
• DBMIN Function
• DBSUM Function
• DELETE_RECORD Method
• DELETED Function
• ENTER RECORD Method
• EVERY_RECORD_LIST Function
• FILTER_STRING Function
• form_qs_explicit Function
• IS_RECNO_IN Function
• LOOKUP Function
• LOOKUPC Function
• LOOKUPD Function
• LOOKUPL Function
• LOOKUPN Function
• MARKED Function
• page_records_get Function
• POP_STDDEV Function
• POP_VARIANCE Function
• RANDOM_PCT_RECORD_LIST Function
• RANDOM_PERCENT_RECORDS Function
• RANDOM_RECORD_LIST Function
• RANDOM_RECORDS Function
• RECORD_ADD Function
• RECORD_DELETE Function
• RECORD_UPDATE Function
• RUN_AVERAGE Function
• RUN_MAXIMUM Function
• RUN_MINIMUM Function
• RUN_STDDEV Function
• RUN_VARIANCE Function
• SAMPLE_RECORDS Function
• STDDEV Function
• TOP_PERCENT_RECORDS Function
• TOP_RECORDS Function
• TOP_RECORDS_LIST Function
• TOP_RECORDS_PCT_LIST Function
• VARIANCE Function

FILTER_STRING Function

Syntax

Arguments

Output_List

A character string separated into "records" by the character string Delimiter.

string

A character string to find in each "record" of the Input_List.

sub_string

Character

delimiter

A character string that separates the Input_List into multiple "records".

exclude

Logical. Optional. Default value = .F. (FALSE). .T. = The String_Array[] excludes the "records" that contain sub-string. .F. = The String_Array[] contains only the "records" that contain the Find_String.

Description

Filter in/out words that contain case insensitive sub_string from a list, default delimiter is CR-LF.

Discussion

FILTER_STRING() takes an Input_List that is divided into logical "records" by a Delimiter and either extracts or excludes the "records" that contain the Find_String characters anywhere within each "record" in the string. Case insensitive. This function is typically used in Xbasic scripts. It is extremely useful for manipulating the CR-LF delimited strings that are returned by many of the Alpha Anywhere methods (such as A5.FORM_ENUM()).

Example

String = <<%a%
Red Ball
Green Ball
Yellow Bucket
Black Hat
%a%
filter_string(string, "black", chr(13) + chr(10) ,.T.)
->   " Red Ball
Green Ball
Yellow Bucket"

This script initializes an array with the forms for the Customer table.

allforms = a5.form_enum()
filtered_forms = filter_string(allforms,"customer.ddd",chr(13) + chr(10))
dim forms200 as C
forms.initialize(filtered_forms)

See Also

• List Processing Functions